home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / newz20.zip / NEWZ.DOC < prev    next >
Text File  |  1992-06-16  |  9KB  |  260 lines
  1. --> NEWZ Ver 2.1  Copyright (c) 1992  Jim Storch
  2.  
  3.         Newz is an RBBS-PC utility for generating the news files
  4.         from user supplied short text files.
  5.  
  6.         I started running a BBS last year and found it very
  7.         annoying to try editing my MAIN.NWS and then using an ansi
  8.         editor to add color to make MAINC.NWS. I run a non-profit
  9.         BBS and didn't want to shell out for a commercial news
  10.         generator, plus I wasn't crazy about the ones I saw,
  11.         so I wrote my own.
  12.  
  13.         In the spirit of RBBS-PC, I'm releasing this to all sysops
  14.         free of charge. This program is not to be sold with the
  15.         exception of a reasonable duplication fee, say a buck or
  16.         two.
  17.  
  18. --> Features
  19.  
  20.         News items are quickly generated by simply writing text
  21.         files with a specified extension.
  22.  
  23.         Up to 50 news files can be handled at a time.
  24.  
  25.         News items are given a "life" span, you can quickly
  26.         create a text to be run from any date to any date.
  27.  
  28.         News items are pre-sorted so that the most recent items are
  29.         displayed first.
  30.  
  31.         Your BBS will display "No news items today" when none are found.
  32.  
  33.         Titles and text are automatically centered within a
  34.         formatted box simulating computer printout.
  35.  
  36.         Creates both plain text, ibm graphic, and ansi color text files
  37.         simultaneously.
  38.  
  39.         Colors and file names are user configurable.
  40.  
  41.         Text files can be optionally deleted by the program
  42.         when they are "outdated" by enabling the LICENSED TO KILL
  43.         parameter.
  44.  
  45.         EASY EASY EASY To set up, run and use!
  46.  
  47. --> How it works
  48.  
  49.         Probably the easiest way to explain the program is to
  50.         describe the configuration file. This is a normal text
  51.         file consisting of nine lines. Here they are, one at a
  52.         time
  53.  
  54. LINE 1
  55.         This line contains the complete path and file name of
  56.         the plain text file used by RBBS-PC for system news,
  57.         normally MAIN.NWS.
  58.  
  59.         example:
  60.  
  61.         C:\RBBS\TEXT\MAIN.NWS
  62.  
  63. LINE 2
  64.         Almost identical as line 1, except this is the complete
  65.         path and file name of the ansi-color text file used for
  66.         system news, normally MAINC.NWS
  67.  
  68.         You can specify whatever paths and filenames you like, but
  69.         for simplicity, these two files will be referred to as
  70.         MAIN & MAINC from here on.
  71.  
  72.         example:
  73.  
  74.         C:\RBBS\TEXT\MAINC.NWS
  75.  
  76. LINE 3
  77.         Again, this is the path/filename of the IBM graphic char
  78.         news file to create, normally maing.nws
  79.  
  80.         example:
  81.  
  82.         C:\RBBS\TEXT\MAIN.NWS
  83.  
  84.  
  85.  
  86. LINE 4
  87.         This is the complete path, wildcard character (*.) and extension
  88.         for the news item text files you will create. I use an extension
  89.         of NWZ to keep it simple, but you can specify whatever extension
  90.         you like.
  91.  
  92.         example:
  93.  
  94.         C:\RBBS\NEWS\*.NWZ
  95.  
  96.         NOTE1 You must include the full path, even if the news files are
  97.         in the same directory as the program.
  98.  
  99.         NOTE2 You must use the asterisk character inside the line. The
  100.         program uses it to parse the path and extension.
  101.  
  102.         NOTE3 If you decide you'd like to use the same extension as
  103.         MAIN and MAINC remember to keep them in separate directories.
  104.         Else, the program will try to open them as news item and you may
  105.         destroy time and space as we know it, (more likely, it would
  106.         read the start and stops dates for both file as 0/0/000AD).
  107.  
  108.         NOTE4 You can use "*.*" for a wildcard if the only files
  109.         in the specified directory are news items. This way you don't
  110.         even have to use an extension.
  111.  
  112.  
  113. LINE 5
  114.         This is a nice feature called LICENSED TO KILL. If this line
  115.         reads "YES" the program is allowed to delete all new items
  116.         that are beyond their stop dates. This allows you to
  117.         fire-and-forget your news text files. If the line is set to
  118.         anything else, old news items will be retained, but
  119.         not included in MAIN/MAINC.
  120.  
  121. LINE 6
  122.         This is the Ansi-color string that will be used for the
  123.         "print-out" BORDER around each news item in the MAINC file.
  124.         Later in this text will be a listing of ansi-color strings and
  125.         how to use them.
  126.  
  127. LINE 7
  128.         This is the Ansi-color string for the TITLE of the news item.
  129.  
  130. LINE 8  This is the Ansi-color string for the TEXT of the news item.
  131.  
  132. LINE9   This is the Ansi-color string for "normal". This line is added
  133.         to the end of each news item, so that if a user ABORT's after the
  134.         first couple items it wont leave the system with strange colored
  135.         text. It also allows you to "type mainc.nws". Set this to whatever
  136.         you use for normal, i.e. non-bold white on black.
  137.  
  138. --> Using Newz
  139.  
  140.         If you're a sysop, you've obviously found a text editor
  141.         of choice. Be sure to use a TEXT EDITOR and not a word
  142.         processor that adds strange formatting characters.
  143.  
  144.          Simply create your news files with the following
  145.         format:
  146.  
  147.         Line1: start date     month/day/year
  148.         Line2: stop date      month/day/year
  149.         Line3: Title
  150.         Line4 -LineX:  Text of message. Be sure to keep each line
  151.                        under 70 characters to keep room for the border.
  152.  
  153.         EXAMPLE:
  154.  
  155.                 10/31/1991
  156.                 11/30/1991
  157.                 NEW CONFERENCES!
  158.                 The BBS now features 5 new discussion topics.
  159.                 1) Sysops who hate their Users.
  160.                 2) Users who hate their Sysops.
  161.                 3) Artificial Intelligence
  162.                 4) C++ Programming
  163.                 5) Komodo Dragons
  164.  
  165.         Next, simply run NEWZxx.EXE. (But, before you do, edit the
  166.         NEWZ.CFG file). The program will take this text file and
  167.         (if the dates are current) generate a plain text MAIN.NWS
  168.         and ansi color MAINC.NWS.
  169.  
  170.         That's all there is to it. You can create up to 50 news text
  171.         files at a time, and NEWZ will include the ones it need.
  172.  
  173.         If the program (1) finds no news item files or (2) finds files,
  174.         but none are current for today, it will create a one line MAIN
  175.         and MAINC saying "No news items today." The MAINC version
  176.         will use the ansi-color selected for TITLE and end with
  177.         the ansi-color for NORMAL
  178.  
  179.         If you add this program to you RBBS-1TM.BAT (or whatever batch
  180.         file you use for periotic maintenance), and enable the
  181.         license-to-kill feature, you will have a fully automated
  182.         news generator that you can add items to in seconds.
  183.  
  184.  
  185. --> Format of Ansi color strings
  186.         (From page 595 of MS-DOS 5.0 User's guide and reference)
  187.  
  188.         Text Attributes               To enter a string just
  189.         0       All attributes off    seperate numbers with a
  190.         1       Bold on (Bright)      semi-colon
  191.         5       Blink on
  192.         7       Reverse Video on      the following example sets
  193.                                       a bright great border with
  194.         Foreground colors             a flashing, bright red title
  195.         30      Black                 and bright blue text, all on
  196.         31      Red                   a black background.
  197.         32      Green
  198.         33      Yellow                0;1;32;40  (BORDER)
  199.         34      Blue                  5;1;31;40  (TITLE)
  200.         35      Magenta               1;34;40    (TEXT)
  201.         36      Cyan                  0;37;40    (set to normal,
  202.         37      White                             white on black).
  203.  
  204.         Background Color
  205.         40      Black
  206.         41      Red
  207.         42      Green
  208.         43      Yellow
  209.         44      Blue
  210.         45      Magenta
  211.         46      Cyan
  212.         47      White
  213.  
  214.  
  215.         If you are curious, ansi-color strings begin with "ESC[" and end
  216.         with a lowercase "m". The program automatically adds these to the
  217.         strings in NEWZ.CFG.
  218.  
  219. --> Lastly
  220.  
  221.         If you have any problems or suggestions about NEWZ,
  222.         please drop me a line at
  223.  
  224.         ELECTRIC HARBOR BBS
  225.         (703) 730-0542
  226.  
  227.         Jim Storch
  228.         3317 Esquarre CT
  229.         Woodbridge, Va
  230.         22193
  231.  
  232.  
  233. Changes for 2.0
  234.  
  235.         You can now enter dates as 10/21/92 or 10/21/1992. Before you
  236.         had to use a four digit year, but this messed some people up.
  237.  
  238.         Fixed a major bug where it would just create the border for the
  239.         news items but leave the body blank. This took me forever to track
  240.         down and, as expected, was a stupid and obvious mistake in my code.
  241.  
  242.         Support for plain old ascii callers. In my first version, I only
  243.         had IBM char and color main.nws files. Now, I create all three.
  244.         This was prompted when I found I had callers with commodore 64's
  245.         using the doors.
  246.  
  247.         News items are centered a hair better on the screen.
  248.  
  249.         QUOTE, quote of the day utilty added. See quote.doc.
  250.  
  251.  
  252.         2.1
  253.  
  254.         License to Kill was botched! Now works.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.